home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 8: LINUX Games / Linux Cubed Series 8 - LINUX Games.iso / games / actionrp / nhplusx.bin / nhplusx / nhplusX / install.txt < prev    next >
Text File  |  1995-09-15  |  8KB  |  186 lines
  1.                 A Guide to Installing and Compiling 
  2.                        NETHACK PLUS on a PC
  3.                 
  4.                 BY: Stephen White (swhite@cs.mun.ca)
  5.  
  6. Ok, I'll try to make this as brief as possable and still contain all the
  7. information you need to know.  Ok, lets begin.
  8.  
  9. FILES:
  10.         
  11.         If you do not have a compiler and haven't access to one then you
  12.         should download the following files:
  13.                 install.txt
  14.                 nhplus01.zip
  15.                 nhplus02.zip
  16.                 djgpp.zip
  17.         Should you already have a compiler that is setup and working
  18.         you only need to download the nhplus.zip file.
  19.  
  20.         NOTE: Be sure to set transfer to BINARY before downloading :)
  21.  
  22. UNPACKING:
  23.         
  24.         Ok, assuming you have pkunzip, you first have to make a directory
  25.         called c:\nh (I will also assume that you are using a PC with 
  26.         a c drive, if you arn't using such a beast, the dir structure
  27.         should still be about the same) and copy ALL the files you have 
  28.         downloaded into it.
  29.  
  30.         Then type EXACTLY: pkunzip -d nhplus01.zip
  31.                            pkunzip -d nhplus02.zip
  32.         
  33.         Next create a directorie called c:\djgpp.old
  34.  
  35.         Then, while still in the c:\nh directory type:
  36.                 pkunzip -d djgpp.zip c:\djgpp.old\*.*
  37.  
  38.         There!  You should be finisher unpacking the archives.
  39.  
  40.         Finally, make a directory c:\nhplus
  41.         
  42.         You should now have a directory structure simmilar to this:
  43.         
  44.         |
  45.         |-nh-.
  46.         |    |-dat (containes data file and special level files)
  47.         |    |-help (all the help files for the game)
  48.         |    |-src (the main code)
  49.         |    |-include (all the header stuff for the code)
  50.         |    |-sys-.
  51.         |    |     |-share (various things)
  52.         |    |     |-msdos (Dos related stuff)
  53.         |    |
  54.         |    |-docs (Ummm ... )
  55.         |    |-util (utilites used to make the game)
  56.         |
  57.         |-djgpp.old-.
  58.         |           |-ndmake
  59.         |           |-(a lot of sub-directories)
  60.         |-nhplus
  61.         |
  62.  
  63.         If you have more than this it's not bad ... but if you have any
  64.         fewer, something didn't go right.
  65.  
  66. SETUP:
  67.  
  68.         Setup is a very simple process. Make a backup copy of your 
  69.         autoexec.bat and config.sys and then copy the autoexec.bat and 
  70.         config.sys from c:\nh to c:\, or just copy the contents of the
  71.         files into your current autoexec.bat and config.sys. Mind you, 
  72.         the compiler likes to have a lot of memory to work with, so you
  73.         should disable any tsr's and memory managers before starting to
  74.         compile.
  75.  
  76.         NOTE: The compiler will NOT work under (a) Windows (or the like)
  77.               (b) when a memory manager is currently running. Also, the
  78.               executable will not work under these conditions as well.
  79.               This version of DJGPP is old ... but works better when you
  80.               have a 386 or low memory (like me :). There is another version
  81.               that will work under windows and with memory managers, but I
  82.               will not deal with that now. If you have interest in such a 
  83.               beast, contact me and I will give you details on it's where
  84.               abouts and what not.
  85.  
  86.         This step is VERY IMPORTANT!  Go to c:\nh\sys\msdos and read the
  87.         install.dos file and follow all of the steps.  Most of the setup 
  88.         should be done already but you should re-check all of them.
  89.         A lot of the personal preferances are selected in the steps outlined
  90.         in the install.dos so read carefully. 
  91.  
  92.         NOTE: In install.dos, when it tells you to 'make all' in a certain
  93.         directory just go to that specified directory and type MAKE45. Or,
  94.         if you are recompiling the WHOLE program (or if you are compiling
  95.         it for the first time) you can also use the batch file I created 
  96.         to do the job for you, it's loacted in c:\nh\util and is called
  97.         'makeall.bat'
  98.  
  99. COMPILING:
  100.  
  101.         If you followed the steps in the install.dos you should already
  102.         have compiled you own copy of Nethack Plus.  Now, a few more
  103.         things need to be done before you can begin Hacking ...
  104.  
  105.         Go to the c:\nh\dat directory and use the "move.bat" file to put all 
  106.         the necessary files in the game directory (if you didn't use c:\nhplus,
  107.         you better change the file :)
  108.  
  109.         If it tells you it can't find go32.exe then copy 
  110.         c:\djgpp.old\bin\go32.exe to c:\nhplus.
  111.  
  112. MAKEFILES:
  113.  
  114.         Yes, as you may have already noticed there are three makefiles.
  115.         One located in c:\nh\util, c:\nh\dat and c:\nh\src.
  116.  
  117.         This is not bad planing but was done on purpose to help prevent 
  118.         non-workable nethack.exe's and a lot on un-necessary compiling.
  119.  
  120.         The makefile in c:\nh\util creates several executables which are
  121.         used throughout the compiling precess, in addition it also creates
  122.         the recover.exe for recovering from a crashed game. It also 
  123.         creates onames.h and pm.h (which are loacted in the c:\nh\include
  124.         dir), these files contain all the item and monster defines ...
  125.         NEVER, NEVER EVER, edit or change these in any way. If you do,
  126.         9 chanches out of ten you will end up with a non-playable 
  127.         executable. When ever you make45 this file treat it as if you 
  128.         were compileing NH for the first time and follow the steps I
  129.         outlined above (excluding checking install.dos)
  130.  
  131.         The makefile in c:\nh\dat can be executed (via make45) at any time
  132.         without the need to re-compiling the whole thing, just be sure
  133.         to copy the re-maked files from this directory to c:\nhplus (see 
  134.         above for detailes on which files need to be copied)
  135.  
  136.         The final makefile in c:\nh\src can be executed at any time
  137.         without need of any coping or re-compiling. It will create the
  138.         the nethack.exe in the c:\nhplus dir. By doing this, you update the
  139.         version of nethack, thereby destroying any saved games or bones
  140.         levels ... sorry. Only those *.c files that have been edited
  141.         will be recompiled (or if the a *.o file is missing) so this is 
  142.         useful for making minor changes to the source. 
  143.         
  144.         PLEASE NOTE: If you add any new objects to objects.c you will
  145.                      need to recompile the game (makeall in c:\nh\util),
  146.                      however if you mearly change object stat, you may not
  147.                      have to do a full compile.
  148.  
  149. ADDITIONAL NOTES:
  150.  
  151.         Here are a few general rules for compiling NH:
  152.                 (1) If you change or edit ANY of the *.h files in the 
  153.                     c:\nh\include directory you MUST recompile the
  154.                     whole game. If you don't ... strange things will
  155.                     happen.
  156.  
  157.                 (2) As a rule, the makefile checks the time stamp on
  158.                     each file to be compiled, if it finds that one or
  159.                     more of the *.h files has changed it will attempt to
  160.                     recompile. If this occures for no apparent reason
  161.                     then you probally have a mismatched time stamp
  162.                     somewhere. Be sure you time and date are set correctly.
  163.  
  164.                 (3) If you want to recompile only a few files in the 
  165.                     c:\nh\src directory just edit them or use touch.exe in
  166.                     the c:\nh\ndmake directory to adjust the time stamp.
  167.                     Then simply make45 in the c:\nh\src directory, the
  168.                     makefile should automatically remake only those files
  169.                     who have been edited. If this is not he case, then 
  170.                     there is probally a mismatched time stamp SOMEWHERE :)
  171.  
  172.                 (4) If you ever recompile the game, make sure to run 
  173.                     "move.bat" in the c:\nh\dat directory or bad things 
  174.                     may happen if you don't.
  175.  
  176. Well, that should get you through compiling NH, if you encounter any 
  177. problems not explaned here just E-Mail me at swhite@cs.mun.ca
  178. (or swhite@garfield.cs.mun.ca if that bounces ... and if THAT doesn't work, 
  179. you could even try swhite@ftp.krl.caltech.edu), make sure to send
  180. the subject as COMPILE PROBLEM ... otherwise I might not read it for
  181. a few days (I've been getting a LOT of mail lately ... wonder why? :)
  182.  
  183.  
  184.  
  185.         
  186.